<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="KEYWORDS" content="SAPlink:Docs:UserDoc" />
<meta name="robots" content="index,follow" />
<link rel="shortcut icon" href="/favicon.ico" />
    <title>SAPlink:Docs:UserDoc - Skunkwerkz</title>
    <style type="text/css" media="screen,projection">/*<![CDATA[*/ @import "main.css"; /*]]>*/</style>
    <link rel="stylesheet" type="text/css" media="print" href="/mediawiki/skins/common/commonPrint.css" />
    <!--[if lt IE 5.5000]><style type="text/css">@import "/mediawiki/skins/monobook/IE50Fixes.css";</style><![endif]-->
    <!--[if IE 5.5000]><style type="text/css">@import "/mediawiki/skins/monobook/IE55Fixes.css";</style><![endif]-->
    <!--[if gte IE 6]><style type="text/css">@import "/mediawiki/skins/monobook/IE60Fixes.css";</style><![endif]-->
    <!--[if IE]><script type="text/javascript" src="/mediawiki/skins/common/IEFixes.js"></script>
    <meta http-equiv="imagetoolbar" content="no" /><![endif]-->
    <script type="text/javascript" src="/mediawiki/index.php?title=User:Dan_Mcweeney/-&amp;action=raw&amp;gen=js&amp;maxage=18000"></script>    <script type="text/javascript" src="/mediawiki/skins/common/wikibits.js"></script>
    <style type="text/css">/*<![CDATA[*/
@import "/mediawiki/index.php?title=MediaWiki:Monobook.css&action=raw&ctype=text/css&smaxage=18000";
@import "/mediawiki/index.php?title=-&action=raw&gen=css";
/*]]>*/</style>          </head>
  <body         class="ns-0">
    <div id="globalWrapper">
      <div id="column-content">
	<div id="content">
	  <a name="top" id="contentTop"></a>
	  	  <h1 class="firstHeading">SAPlink:Docs:UserDoc</h1>
	  <div id="bodyContent">
	    <h3 id="siteSub">From Skunkwerkz</h3>
	    <div id="contentSub"></div>
	    	    	    <!-- start content -->
	    <table border="0" id="toc"><tr id="toctitle"><td align="center">
<b>Table of contents</b> <script type="text/javascript">showTocToggle("show","hide")</script></td></tr><tr id="tocinside"><td>
<div class="tocline"><a href="#Install">1 Install</a><br /></div>
<div class="tocindent">
<p><a href="#Initial">1.1 Initial</a><br />
<a href="#Plugins">1.2 Plugins</a><br />
<a href="#Upgrade">1.3 Upgrade</a><br />
</p>
</div>
<div class="tocline"><a href="#Usage">2 Usage</a><br /></div>
<div class="tocindent">
<p><a href="#Slinkee">2.1 Slinkee</a><br />
</p>
<div class="tocindent">
<p><a href="#Import">2.1.1 Import</a><br />
<a href="#Export">2.1.2 Export</a><br />
</p>
</div>
<p><a href="#Nugget">2.2 Nugget</a><br />
</p>
<div class="tocindent">
<p><a href="#Import_2">2.2.1 Import</a><br />
<a href="#Create_New_Nugget">2.2.2 Create New Nugget</a><br />
<a href="#Exporting.2FAdding_Objects_to_Existing_Nugget">2.2.3 Exporting/Adding Objects to Existing Nugget</a><br />
<a href="#Display_Objects_in_Nugget">2.2.4 Display Objects in Nugget</a><br />
</p>
</div>
</div>
<div class="tocline"><a href="#Bug_Reporting.2FFeature_Requests">3 Bug Reporting/Feature Requests</a><br /></div>
<div class="tocline"><a href="#Contributors">4 Contributors</a><br /></div>
</td></tr></table>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=1" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Install"></a><h1>Install</h1>
<ul><li><i>Known ABAP basis versions compatible with SAPlink include: </i>
<ul><li>6.20
</li><li>6.40(Netweaver 2004)
</li><li>7.0(Netweaver 2004s)<i></i>
</li></ul>
</li></ul>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=2" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Initial"></a><h2>Initial</h2>
<ol><li>Download the latest version of the SAPlink installer zip file from the <a href="http://code.google.com/p/saplink/" class='external' title="http://code.google.com/p/saplink/" rel="nofollow">SAPlink Project page</a><span class='urlexpansion'>&nbsp;(<i>http://code.google.com/p/saplink/</i>)</span> which contains the following files:
<ol><li> SAPlink_installer.txt - hopefully the last program you will ever have to copy and paste
</li><li> NUGG_SAPLINK.nugg - nugget containing necessary objects to install
</li><li> ReadMe.pdf - PDF document with contributors and these instructions
</li><li> COPYING - text document with GNU GENERAL PUBLIC LICENSE
</li></ol>
</li><li>Extract contents of the SAPlink installer zip file
</li><li>Copy, paste, save, and activate the contents of the SAPlink_installer.txt file into a new program ZSAPLINK_INSTALLER onto the target SAP system
</li><li>Execute newly activated program ZSAPLINK_INSTALLER
</li><li>Use the extracted file NUGG_SAPLINK_INSTALL.nugg for the selection parameter "Installation Nugget" 
</li><li>WARNING: Using checkbox "Overwrite Originals", will overwrite any existing version of the SAPlink objects that were previously installed onto the system.  Only use when reinstalling or installing a major release where a brand new install is required. Otherwise, follow the normal procedures for upgrade below.
</li><li>Execute
</li><li>Newly installed objects need to be activated manually, as all objects are installed as local &amp; inactive 
<ol><li>Run transaction code SE38
</li><li>On initial screen of SE38, enter program name ZSAPLINK into selection parameter "Program" and hit activate command to show worklist
</li><li>On worklist screen, select "Whole Worklist" button on bottom to show all inactive objects in your worklist
</li><li>Select all newly installed SAPlink related objects (ZSAPLINK*) and activate
</li><li>Once activation for all objects is complete, SAPlink can be executed via program ZSAPLINK
</li></ol>
</li></ol>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=3" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Plugins"></a><h2>Plugins</h2>
<ul><li>To see a list of installed plugins, use the F4 value help in the selection parameter field for "Object Type" from ZSAPLINK->Object Tab->Export Object->Object Type.  Additional plugins can be downloaded from the <a href="http://code.google.com/p/saplink/" class='external' title="http://code.google.com/p/saplink/" rel="nofollow">SAPlink Project page</a><span class='urlexpansion'>&nbsp;(<i>http://code.google.com/p/saplink/</i>)</span> and imported/installed using SAPlink. A plugin can be delivered via a Slinkee or a Nugget.  Follow normal usage instructions below for the plugin file accordingly.
</li><li>If no plugin is available for the object type needed, we need your help. If you are a gracious soul and willing to give back to the community as a plugin developer, go to the <a href="http://groups.google.com/group/saplink" class='external' title="http://groups.google.com/group/saplink" rel="nofollow">SAPlink Group</a><span class='urlexpansion'>&nbsp;(<i>http://groups.google.com/group/saplink</i>)</span> and let us know.  Developer documentation is available on the SAPlink documentation page.
</li></ul>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=4" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Upgrade"></a><h2>Upgrade</h2>
<ol><li>Download the latest version of SAPlink or any of the SAPlink plugins from the <a href="http://code.google.com/p/saplink/" class='external' title="http://code.google.com/p/saplink/" rel="nofollow">SAPlink Project page</a><span class='urlexpansion'>&nbsp;(<i>http://code.google.com/p/saplink/</i>)</span>
</li><li>Unless otherwise stated, you can use your existing version of SAPlink to upgrade itself or any of its plugins. Use the downloaded slinkee or nugget file according to the normal usage instructions below
</li></ol>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=5" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Usage"></a><h1>Usage</h1>
<ul><li> To execute SAPlink, use program ZSAPLINK. <i >If you do not know which SAP transaction to use to run this program from, you don't need to be running SAPlink anyway. Please go find and bribe a developer to help you before proceeding.</i >
</li><li>There are two types of files that can be imported or exported using SAPlink, either a Slinkee file (.slnk) or a Nugget file (.nugg).  Both filetypes contain XML representation of the objects to be installed.  They can be read using any XML reader, a text editor, or some compatible browsers (confirmed using Firefox).
</li></ul>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=6" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Slinkee"></a><h2>Slinkee</h2>
<p>A Slinkee file(.slnk) is used for single objects to be imported or exported.  Slinkees are very quick and easy to use &amp; recommended for single object collaboration. They can be imported and exported from the "Object" tab
</p>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=7" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Import"></a><h3>Import</h3>
<ol><li>Select radio button "Import Object"
</li><li>Use the Slinkee file containing the object to be imported in the selection parameter "SAPlink File Name" 
</li><li>WARNING: Using checkbox "Overwrite Originals", will overwrite any existing object with the same type and name on the target system. Be sure you know
</li><li>Execute
</li><li>Newly installed objects need to be activated manually, as all objects are installed as local &amp; inactive
</li></ol>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=8" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Export"></a><h3>Export</h3>
<ol><li>Select radio button "Export Object"
</li><li>Enter the name of the object to be exported for the selection parameter "Object Name". <i >Your object name should be somewhat unique. Remember that you will be sharing your objects with other developers and they probably already have a program called ZFoo, ZMyTest, or ZINeedARaise. An object that is not unique for that object type, will have to be overwritten in order to be installed on the target system</i >
</li><li>In the "Object Type" selection parameter, use the F4 value help selection to
<ol><li>See a list of installed plugins and their compatible object types
</li><li>Enter the R3TR type of the object to be exported for the selection parameter "Object Type"
</li></ol>
</li><li>Execute and save file to local machine when prompted. <i >To meet standards for object collaboration, it is recommended, yet not technically required to use the suggested default file name</i >
</li></ol>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=9" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Nugget"></a><h2>Nugget</h2>
<p>SAPlink nuggets is the SAPlink packaging system that enables multiple objects to be imported/exported in one handy dandy file(.nugg). Nuggets can be imported, created, and displayed from the "Nugget" tab
</p>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=10" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Import_2"></a><h3>Import</h3>
<ol><li>Select radio button "Import Nugget"
</li><li>Use the Nugget file containing the objects to be imported in the selection parameter "Nugget File Name" 
</li><li>WARNING: Using checkbox "Overwrite Originals", will overwrite any existing object with the same type and name on the target system. Be sure you know
</li><li>Execute
</li><li>Newly installed objects need to be activated manually, as all objects are installed as local &amp; inactive
</li><li>To see a list of all objects in a nugget, use the option to "Display Objects in Nugget"
</li></ol>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=11" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Create_New_Nugget"></a><h3>Create New Nugget</h3>
<ol><li>Select radio button "Create Empty Nugget"
</li><li>Type the Name of your Nugget in, this should be as unique as possible as upcoming releases may include versioning.  <i>If you do not give your Nugget a unique name you will have problems later.  Avoid things like TEST, FOO, or BAR as these are probably not unique.  By the same token don't name it 9283kasdfasdbfasdfksfdf9823498jfsaa as this is useless and makes no sense.</i>
</li><li>Press Execute, SAPlink will ask you where to put the Nugget file
</li><li>You should now see your empty Nugget file in the target directory
</li><li>You can now start adding Objects to your Nugget
</li></ol>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=12" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Exporting.2FAdding_Objects_to_Existing_Nugget"></a><h3>Exporting/Adding Objects to Existing Nugget</h3>
<ol><li>Select radio button "Add Object to Nugget"
</li><li>Type the Object Name
</li><li>Pick Object Type from the value help of installed plugins
</li><li>Pick the Nugget File you wish to add this object to
</li><li>Press Execute
</li><li>If everthing goes well you will see a confirmation message of the amount of bytes saved on your local machine
</li></ol>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=13" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Display_Objects_in_Nugget"></a><h3>Display Objects in Nugget</h3>
<ul><li>Use this while building or before installing a Nugget to see what you've got in there, simply point it at the File Name of a Nugget on your local machine to see the list
</li></ul>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=14" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Bug_Reporting.2FFeature_Requests"></a><h1>Bug Reporting/Feature Requests</h1>
<p>Please submit all bug reports and feature requests at the <a href="http://groups.google.com/group/saplink" class='external' title="http://groups.google.com/group/saplink" rel="nofollow">SAPlink Group</a><span class='urlexpansion'>&nbsp;(<i>http://groups.google.com/group/saplink</i>)</span>
</p>
<div class="editsection" style="float:right;margin-left:5px;">[<a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit&amp;section=15" title="SAPlink:Docs:UserDoc">edit</a>]</div><a name="Contributors"></a><h1>Contributors</h1>
<pre>
*/---------------------------------------------------------------------\
*| /  __ \           | |      (_) |         | |                        |
*| | /  \/ ___  _ __ | |_ _ __ _| |__  _   _| |_ ___  _ __ ___         |
*| | |    / _ \| '_ \| __| '__| | '_ \| | | | __/ _ \| '__/ __|        |
*| | \__/\ (_) | | | | |_| |  | | |_) | |_| | || (_) | |  \__ \        |
*|  \____/\___/|_| |_|\__|_|  |_|_.__/ \__,_|\__\___/|_|  |___/        |
*|---------------------------------------------------------------------|
*| Lead Developers&nbsp;: ed herrmann                                       |
*|                        ewherrmann+saplinkcred@gmail.com             |
*|                   dan mcweeney                                      |
*|                        daniel.mcweeney+saplinkcred@gmail.com        |
*|                                                                     |
*| Fearless Alpha Testers: Matthew Ammons                              |
*|                         Phillip T Young                             |
*|                         Ryan Quackenboss                            |
*|                         Todd Rowland                                |                     
*\---------------------------------------------------------------------/</pre>

<!-- Saved in parser cache with key wikidb:pcache:idhash:1063-1!1!0!1!0!1!!0!en and timestamp 20060906184722 -->
<div class="printfooter">
Retrieved from "<a href="http://167.228.52.177/mediawiki/index.php/SAPlink:Docs:UserDoc">http://167.228.52.177/mediawiki/index.php/SAPlink:Docs:UserDoc</a>"</div>
	    	    <!-- end content -->
	    <div class="visualClear"></div>
	  </div>
	</div>
      </div>
      <div id="column-one">
	<div id="p-cactions" class="portlet">
	  <h5>Views</h5>
	  <ul>
	    <li id="ca-nstab-main"
	       class="selected"	       ><a href="/mediawiki/index.php/SAPlink:Docs:UserDoc">Article</a></li><li id="ca-talk"
	       class="new"	       ><a href="/mediawiki/index.php?title=Talk:SAPlink:Docs:UserDoc&amp;action=edit">Discussion</a></li><li id="ca-edit"
	       	       ><a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=edit">Edit</a></li><li id="ca-history"
	       	       ><a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=history">History</a></li><li id="ca-protect"
	       	       ><a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=protect">Protect</a></li><li id="ca-delete"
	       	       ><a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=delete">Delete</a></li><li id="ca-move"
	       	       ><a href="/mediawiki/index.php?title=Special:Movepage&amp;target=SAPlink%3ADocs%3AUserDoc">Move</a></li><li id="ca-watch"
	       	       ><a href="/mediawiki/index.php?title=SAPlink:Docs:UserDoc&amp;action=watch">Watch</a></li>	  </ul>
	</div>
	<div class="portlet" id="p-personal">
	  <h5>Personal tools</h5>
	  <div class="pBody">
	    <ul>
	    <li id="pt-userpage"><a href="/mediawiki/index.php/User:Dan_Mcweeney" class="new">Dan Mcweeney</a></li><li id="pt-mytalk"><a href="/mediawiki/index.php/User_talk:Dan_Mcweeney" class="new">My talk</a></li><li id="pt-preferences"><a href="/mediawiki/index.php/Special:Preferences">Preferences</a></li><li id="pt-watchlist"><a href="/mediawiki/index.php/Special:Watchlist">My watchlist</a></li><li id="pt-mycontris"><a href="/mediawiki/index.php?title=Special:Contributions&amp;target=Dan+Mcweeney">My contributions</a></li><li id="pt-logout"><a href="/mediawiki/index.php?title=Special:Userlogout&amp;returnto=SAPlink:Docs:UserDoc">Log out</a></li>	    </ul>
	  </div>
	</div>
	<div class="portlet" id="p-logo">
	  <a style="background-image: url(/mediawiki/skins/common/images/wiki.png);"
	    href="/mediawiki/index.php/Main_Page"
	    title="Main Page"></a>
	</div>
	<script type="text/javascript"> if (window.isMSIE55) fixalpha(); </script>
	<div class="portlet" id="p-nav">
	  <h5>Navigation</h5>
	  <div class="pBody">
	    <ul>
	      	      <li id="n-mainpage"><a href="/mediawiki/index.php/Main_Page">Main Page</a></li>	      <li id="n-bugzilla"><a href="http://167.228.52.177/bugzilla">the BugWerkz</a></li>	      <li id="n-recentchanges"><a href="/mediawiki/index.php/Special:Recentchanges">Recent changes</a></li>	      <li id="n-help"><a href="/mediawiki/index.php/Help:Contents">Help</a></li>	    </ul>
	  </div>
	</div>
	<div id="p-search" class="portlet">
	  <h5><label for="searchInput">Search</label></h5>
	  <div class="pBody">
	    <form name="searchform" action="http://167.228.52.177/nutch/search.jsp" id="searchform">
	      <input id="searchInput" name="query" type="text"
	        accesskey="f" value="" />
	      <input type='submit' name="go" class="searchButton" id="searchGoButton"
	        value="Go"
	        />&nbsp;<input type='submit' name="fulltext"
	        class="searchButton"
	        value="Search" />
	    </form>
	  </div>
	</div>
	<div class="portlet" id="p-tb">
	  <h5>Toolbox</h5>
	  <div class="pBody">
	    <ul>
		  		  <li id="t-whatlinkshere"><a href="/mediawiki/index.php?title=Special:Whatlinkshere&amp;target=SAPlink%3ADocs%3AUserDoc">What links here</a></li>
		  		  <li id="t-recentchangeslinked"><a href="/mediawiki/index.php?title=Special:Recentchangeslinked&amp;target=SAPlink%3ADocs%3AUserDoc">Related changes</a></li>
		  	      	      	      	      	      	      	      <li id="t-upload"><a href="/mediawiki/index.php/Special:Upload">Upload file</a></li>	      	      <li id="t-specialpages"><a href="/mediawiki/index.php/Special:Specialpages">Special pages</a></li>	      	    </ul>
	  </div>
	</div>
	      </div><!-- end of the left (by default at least) column -->
      <div class="visualClear"></div>
      <div id="footer">
    <div id="f-poweredbyico"><a href="http://www.mediawiki.org/"><img src="/mediawiki/skins/common/images/poweredby_mediawiki_88x31.png" alt="MediaWiki" /></a></div>		<ul id="f-list">
	  <li id="f-lastmod"> This page was last modified 14:47, 6 Sep 2006.</li>	  <li id="f-viewcount">This page has been accessed 36 times.</li>	  	  	  <li id="f-about"><a href="/mediawiki/index.php/Skunkwerkz:About" title="Skunkwerkz:About">About Skunkwerkz</a></li>	  <li id="f-disclaimer"><a href="/mediawiki/index.php/Skunkwerkz:General_disclaimer" title="Skunkwerkz:General disclaimer">Disclaimers</a></li>	</ul>
      </div>
    </div>
    <!-- Served by localhost.localdomain in 0.75 secs. -->
  </body>
</html>
